/*
 * Copyright (c) 2015, 2025, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.svm.core;

import org.graalvm.nativeimage.Platform;
import org.graalvm.nativeimage.Platforms;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.function.BooleanSupplier;

/**
 * Every thus annotated method is never trivially inlined by the compiler. Specific inlining to
 * broaden the scope of the PartialEscapePhase is still possible.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
@Platforms(Platform.HOSTED_ONLY.class)
public @interface NeverInlineTrivial {

    /**
     * Documents the reason why the annotated code must not be inlined.
     */
    String reason();

    /**
     * Prevent inlining only if all of the provided predicates are true (default: a predicate that
     * always prevents inlining).
     *
     * The classes must implement {@link BooleanSupplier}.
     */
    Class<?>[] onlyWith() default NeverInlined.class;

    /**
     * A BooleanSupplier that always returns true, used to indicate methods should never be inlined.
     * This serves as the default value for the {@link NeverInlineTrivial#onlyWith()} attribute,
     * preventing inlining by default.
     */
    final class NeverInlined implements BooleanSupplier {
        NeverInlined() {
        }

        @Override
        public boolean getAsBoolean() {
            return true;
        }
    }
}
